home *** CD-ROM | disk | FTP | other *** search
/ Network CD 2 / Network CD - Volume 2.iso / legaltools / lsdlt036.dms / lsdlt036.adf / docs / xDrop.doc.pp / xDrop.doc
Encoding:
Text File  |  1990-09-13  |  11.9 KB  |  359 lines
  1. xDrop 2.12
  2. ==========
  3.  
  4. XPK-based Workbench packer/unpacker.
  5.  
  6. (XPK-basierter Packer und Entpacker für die Workbench.
  7. Deutsche Übersetzung der Anleitung in Vorbereitung.
  8. Freiwillige vor! ;-)
  9.  
  10.  
  11. ------------------------------------------------------------------------
  12. Versions
  13. --------
  14.  
  15. 2.0  - First version, distrbuted with xpk 1.0
  16. 2.01 - Small bug fix (original window positioning was wrong)
  17. 2.02 - Memory leek fixed
  18. 2.1  - Layout slightly changed, larger listview, mode descriptor
  19. 2.11 - Bug causing Enforcer hit in panel disable code fixed 
  20.        (Ch. Schneider)
  21. 2.12 - Bug with long filenames fixed
  22.  
  23.  
  24. ------------------------------------------------------------------------
  25. Disclaimer
  26. ----------
  27.  
  28. xDrop ist Copyright © 1992 by Martin A. Blatter. All rights reserved.
  29.  
  30. xDrop may be freely distributed for non-commercial purposes only!
  31.  
  32. The entire risk as to the quality and performance of this program is 
  33. with you. The author assumes no responsibility or liability whatsoever 
  34. with respect to your use or inability to use of this software.
  35.  
  36.  
  37. ------------------------------------------------------------------------
  38. Purpose
  39. -------
  40.  
  41. xDrop is an easy to use visual user interface to the XPK library
  42. system. It allows you to choose from different packers and 
  43. different operation modes by a simple mouse click. 
  44.  
  45. It sports a Style Guide compliant user interface and uses Workbench
  46. 2.0's appicon and appwindow features to make operation as simple and
  47. convenient as possible. Through the use of Commodore-Amiga's 
  48. commodities.library, xDrop can be installed on any hotkey and
  49. fully controlled with the Commodoties Exchange program.
  50.  
  51.  
  52. ------------------------------------------------------------------------
  53. Requirements
  54. ------------
  55.  
  56. · Any Amiga
  57. · Kickstart 2.0 or higher
  58. · The xpk package (xpkmaster.library and at least one sublibrary)
  59.  
  60.  
  61. ------------------------------------------------------------------------
  62. Start xDrop
  63. -----------
  64.  
  65. xDrop can be used either from Workbench or from the CLI.
  66.  
  67.  
  68. * Workbench use
  69.  
  70.   Double click on the xDrop icon. An appicon will appear on the
  71.   Workbench screen. If this appicon doesn't appear several things could 
  72.   have gone wrong:
  73.  
  74.   · Do you use Kickstart 2.0 or higher?
  75.   · Is there any memory left on your system?
  76.   · Do you have commodities.library (supplied with Workbench 2.04)
  77.     in libs:?
  78.   · Is the xpk package properly installed?
  79.  
  80.   Requesters will try to tell you the cause if xDrop fails to run.
  81.  
  82.   If the tool type `CX_POPUP' (see below for an explanation of tool
  83.   types) is set to `yes', a configuration window will appear. See
  84.   the section entitled `Configuration Window' for more information 
  85.   about this window.
  86.  
  87.  
  88. * CLI use
  89.  
  90.   Type 'xDrop' in any Shell window. An appicon will appear on the
  91.   Workbench screen.
  92.  
  93.   To remove xDrop from memory, just press CONTROL-C in the Shell
  94.   window where xDrop has been started from.
  95.  
  96.  
  97. ------------------------------------------------------------------------
  98. Operation
  99. ---------
  100.  
  101. Operation of xDrop is very easy:
  102.  
  103. To compress files:
  104.  
  105.    Just select one or more icons on the Workbench, drag them to the
  106.    xDrop appicon or the xDrop configuration window (if it's open)
  107.    and drop them.
  108.  
  109.    The Progress Report Window (see below) will appear and the file 
  110.    will be compressed using the packer selected in the configuration 
  111.    window or pre-set with the XPK_METHOD tool type (see below for
  112.    a discussion of tool types).
  113.  
  114. To uncompress files:
  115.  
  116.    To uncompress a compressed file, drag its icon on the xDrop
  117.    appicon or the xDrop configuration window (if it's open).
  118.  
  119.    You may drop arbitrary many icons, compressed or uncompressd
  120.    simultaneously on xDrop.
  121.  
  122. To remove xDrop from memory:
  123.  
  124.    xDrop can be removed from memory at any time.
  125.  
  126.    - Use the `Commodities Exchange' program to kill xDrop
  127.    - Send xDrop a CTRL-C signal with the `break' command
  128.    - Run another copy of xDrop. Both xDrop processes will quit
  129.      immediately.
  130.  
  131.  
  132. ------------------------------------------------------------------------
  133. Configuration Window
  134. --------------------
  135.  
  136. The configuration window is divided into three visually separated
  137. parts labelled `Packer', `Settings' and `Description':
  138.  
  139.  
  140. ________________________________________________________________
  141. |                                                              |
  142. |    Packer                        Description                 |
  143. | ____________     ___________________________________________ |
  144. | |          |     |                                         | |
  145. | |          |     |                                         | |
  146. | |          |     |                                         | |
  147. | |          |     |                                         | |
  148. | |          |     |                                         | |
  149. | |          |     ------------------------------------------| |
  150. | |          |                                                 |
  151. | |          |                       Settings                  |
  152. | |          |                                                 |
  153. | |          |                        ________________________ |
  154. | ------------                        |                      | |
  155. | |          |                        |----------------------| |
  156. | ------------                        |______________________| |
  157. |                                                              |
  158. | ____________                                    ____________ |
  159. | |   Save   |                                    |   Hide   | |
  160. | ------------                                    ------------ |
  161. ----------------------------------------------------------------
  162.  
  163.  
  164. 1. Packer
  165.  
  166. The Packer list view allows you to choose from a list of available
  167. XPK packers and encryptors by clicking on its entry. (The packer 
  168. libraries are usually located in the drawer `libs:compressors'). 
  169. The recessed box below the list view shows the selected packer
  170.  
  171.  
  172. 2. Description
  173.  
  174. This view-only box displays more information about the currently 
  175. selected packer/encryptor consisting of the full name of 
  176. the packer and two lines of additional information.
  177.  
  178.  
  179. 3. Settings
  180.  
  181. The Settings part of the configuration window consists of two
  182. gadgets that can be ghosted, depending of the capabilities of the
  183. currently selected packer:
  184.  
  185.    A. Efficiency
  186.  
  187.       This proportional gadget allows you to manipulate the
  188.       efficiency of the packer. The value for efficiency 
  189.       can be in the range from 0 to 100%. Neither must every 
  190.       packer support 100 different levels nor does every packer
  191.       have more than one level.
  192.  
  193.       An ASCII name of the current efficiency level can be obtained
  194.       by selecting the `Mode Info' menu.
  195.  
  196.       The ASCII name is now also being displayed at the left
  197.       side of the proportional gadget
  198.  
  199.    B. Password
  200.  
  201.       This string gadget allows you to specify a password for
  202.       packers that support data encryption.
  203.       The password may not be longer than 15 characters.
  204.  
  205.  
  206. 4. Buttons
  207.  
  208.    A. Save
  209.  
  210.       Saves the current settings to the xdrop disk icon.
  211.       Keyboard equivalent: S
  212.  
  213.    B. Hide
  214.  
  215.       Hides the configuration window but doesn't quit xDrop.
  216.       Uses the current configuration settings but doesn't save 
  217.       them.
  218.       Keyboard equivalent: H
  219.  
  220.  
  221. 5. Close gadget
  222.  
  223. The window close gadget does exactly the same as the `Hide' button.
  224.  
  225.  
  226. 6. Menus
  227.  
  228.    A. Project
  229.  
  230.       About - Displays information about the program and its author
  231.               Keyboard equivalent: Rt. Amiga - A
  232.  
  233.       Mode Info - Display settings and additional information for 
  234.                   the currently selected packer.
  235.                   Keyboard equivalent: Rt. Amiga - I
  236.  
  237.       Hide - Hides the configuration window but doesn't quit xDrop.  
  238.              Uses the current configuration settings but doesn't save
  239.              them.
  240.              Keyboard equivalent: Rt. Amiga - H
  241.  
  242.       Quit - Completely removes xDrop from memory.
  243.  
  244.    B. Option
  245.  
  246.       Keep Original - If checked, xDrop will save the original
  247.                       file and append `.xpk' to the filename
  248.                       for the compressed version of the file.
  249.                       Icons will be copied as well. The `.xpk'
  250.                       extension will be deleted when the file
  251.                       is going to be decompressed.
  252.  
  253.                       If the menu item is not checked, xDrop
  254.                       will overwrite the original with the
  255.                       compressed version.
  256.  
  257.  
  258. ------------------------------------------------------------------------
  259. Progress Report Window
  260. ----------------------
  261.  
  262. While packing/unpacking, xDrop will show a progress report. A bar that
  263. moves from the left to the right shows the degree of completion. This 
  264. will not work with all packers, some will only show a change when done.
  265. The progress report also shows the amount of bytes already processed,
  266. the total amount of bytes to be processed and the (de)compression speed. 
  267. (De)compression can be aborted using the close gadget; you will not lose 
  268. any data. xDrop never overwrites the original before having sucessfully 
  269. completed the (de)compression.
  270.  
  271.  
  272. ------------------------------------------------------------------------
  273. Tool Types
  274. ----------
  275.  
  276. The following tool types are supported:
  277.  
  278.  
  279. CX_POPUP  - If you want the xDrop configuration window to pop up the 
  280.             first time you double-click on the xDrop disk icon, set 
  281.             this to yes: 
  282.                         CX_POPUP=yes
  283.  
  284.             If you want xDrop to run in the background the first
  285.             time it is being started e.g. if you're running it from the
  286.             WBStartup drawer, set this to no:
  287.                         CX_POPUP=no
  288.  
  289. CX_POPKEY - Key combination for the commodity `hotkey'. Default:
  290.                         CX_POPKEY=alt shift f9
  291.  
  292. CX_PRIORITY Commodity priority. Default value:
  293.                         CX_PRIORITY=0
  294.  
  295. XPK_METHOD - Sets the default packer. This tool type will be maintained
  296.              by the configuration window as should not be changed by
  297.              the user.
  298.                         XPK_METHOD=NUKE
  299.  
  300. XPK_PRIORITY - Sets the task priority of the packing/unpacking task.
  301.                Don't change this value unless you know what you're doing.
  302.                Default value: 0
  303.  
  304. LANGUAGE  - Determines the language to use for the user interface
  305.             Possible values: 
  306.                        LANGUAGE=German
  307.                        LANGUAGE=English
  308.             This tool type overrides global language settings. Remove
  309.             it if you want to use the system's default language...
  310.  
  311. ICONNAME  - Allows you to specify the label string of the appicon.
  312.             Example:
  313.                        ICONNAME=Slurp
  314.  
  315. ICONXPOS  - Sepcifies the desired x coordinate of the appicon. Note that
  316.             as of Kickstart 2.0, Workbench may move your icon to another 
  317.             position than specified here.
  318.             Example:
  319.                        ICONXPOS=600
  320.  
  321. ICONXPOS  - Sepcifies the desired y coordinate where the appicon should
  322.             appear. Note that as of Kickstart 2.0, Workbench may move your 
  323.             icon to another position than specified here.
  324.                        ICONYPOS=400
  325.  
  326. KEEPORIGINAL - If this tool type is set to `yes', xDrop will save the 
  327.                original file and append `.xpk' to the filename for the 
  328.                compressed copy of the file. Icons will be copied as well. 
  329.                The `.xpk' extension will be deleted when the file
  330.                is going to be decompressed.
  331.  
  332.                If the tool type is set to `no' (the default), xDrop
  333.                will overwrite the original with the compressed version.
  334.  
  335.                Example:
  336.                        KEEPORIGINAL=no
  337.  
  338.  
  339. ------------------------------------------------------------------------
  340. Credits
  341. -------
  342.  
  343. Author: Martin A. Blatter
  344.         Pfaffächerstr. 59
  345.         CH-8913 Ottenbach
  346.         Switzerland
  347.  
  348. E-Mail: blatter@amiga.physik.unizh.ch
  349.         cbmvax!cbmehq!cbmswi!zethos!blatter
  350.  
  351. Bug reports or suggestions are welcome but *please* use e-mail or snail
  352. mail (no phone calls!). Thanks.
  353.  
  354. This program uses Relog AG's ITools(tm), the object-oriented user 
  355. interface system by Christian A. Weber.
  356.  
  357. Special thanks to U. Dominik Mueller for parts of the manual.
  358.  
  359.